Kno2 System API - Implementation Template

Importing templates into Anypoint Studio

1. In Studio, click the Exchange X icon in the upper left of the taskbar.
2. Log in with your Anypoint Platform credentials.
3. Search for the template.
4. Click Open.

Running templates in Anypoint Studio

After you import your template into Studio, use the following configuration steps to run it.

Common Configuration

• mule.env - sets the environment where the application is to be deployed. It should be configured in config-<mule.env>.yaml file. For a studio deployment, the recommended mule.env value is local
• mule.key - sets the encryption password to be used for encrypting secure properties. Update as needed
• api.baseurl - sets the base url of the api. Replace/override as needed when deploying to any environment. It should be configured in config-<mule.env>.yaml file. Default value is https://localhost:8082/api, when mule.env is local
• api.autoDiscoveryId should be configured in config-<mule.env>.yaml file.

Kno2 configuration

• kno2.baseurl - sets the base url for Kno2 service requests. It should be configured in config-<mule.env>.yaml file
• kno2.appId - sets AppId to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file
• kno2.clientId - sets the client id to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file
• kno2.clientSecret - sets the client secret to be used for requests to Kno2 services. It should be encrypted and configured in config-secured-<mule.env>.yaml file
• kno2.requester.requesterId - sets requester's Id to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file
• kno2.requester.fullName - sets requester's fullName to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file
• kno2.requester.roleCode - sets requester's roleCode to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file
• kno2.requester.purposeOfUseCode - sets requester's purposeOfUseCode to be used for requests to Kno2 services. It should be configured in config-<mule.env>.yaml file

Please refer to the attached link on how to secure the configuration properties.

HTTPS Configuration

• https.host — sets the service host interface. It should be configured in config-<mule.env>.yaml file. (Defaults to 0.0.0.0 for all interfaces).
• https.port — sets the HTTPS service port number. It should be configured in config-<mule.env>.yaml file. (Default 8082).
• TLS Configuration - Keystore properties setup:
  • keystore.alias - sets the alias to the keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.path - sets the path to the key file. Key should be available in /src/main/resources/keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.keypass — sets keystore keypass to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.
  • keystore.password— sets keystore password to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.

Please refer to the attached link on how to generate the Keystore.

Assumptions and Constraints

• In order to allow Kno2 to return the results to your client, a greater timeout is recommended. The default value of 'kno2.responseTimeOut' is 120 sec.
• The document that is retrieved from Kno2 System API follows CCDA standards and is in XML format.

Run it

1. Right-click the template project folder.
2. Hover your mouse over 'Run as'.
3. Click Mule Application (configure).
4. Inside the dialog, select Environment and set the variable mule.env to the appropriate value (e.g., dev or local).
5. Inside the dialog, select Environment and set the variable mule.key to the property encryption key that you used to encrypt your secure properties.
6. Click Run.

Deployment instructions for CloudHub using provided scripts

Ensure the Maven profile CloudHub-DEV has been properly configured in your settings.xml file. Reference can be found by downloading the Accelerator Common Resources asset. Additional instructions are available in the Getting Started with MuleSoft Accelerators - Build Environment guide.

Update the config-.yaml properties appropriately and then use one of the following scripts to deploy the application to CloudHub:

• packageDeploy.sh or deployOnly.sh (Mac/Linux)
• packageDeploy.cmd or deployOnly.cmd (Windows)

Testing

• Use Advanced Rest Client or Postman to send request over HTTPS. The template includes a postman collection in src/test/resources folder. Update the collection variable(s) after successful import.